13.3 Standard templates
Standard email templates and triggers are provided with MyID and are used unless you specify something different. The templates contain both fixed text, which is identical in every message, and variables, which are replaced with information stored in MyID and may contain different values in different messages.
|
Template Name |
Description |
ID |
|---|---|---|
|
Apply Update Notification |
Sent to a user who has an update for their card waiting |
6 |
|
Apply Update Notification Mobile |
Sent to the user when update are ready for collection onto their mobile devices |
142 |
|
Authentication Code |
Authentication code for account |
27 |
|
Authentication Code Notification |
Authentication code notification |
26 |
|
Automatic Job Cancellation Email |
Sent to the issue card request recipient when a issuance job is canceled because it has not been collected in time. |
113 |
|
Cancel Card Notification |
Sent to a user whose card has been canceled |
5 |
|
Card PIN Notification |
Sent to inform a user of their new PIN number |
11 |
|
Certificate Authority Status |
Certificate authority status |
106 |
|
Certificate Renewal Not Permitted. User Data Not Approved |
Used to inform a person that they cannot renew their certificates because their User Data Approved flag is not set. |
202 |
|
Certificate Renewal Not Permitted. Vetting Expired |
Used to inform a person that they cannot renew their certificates because their vetting has expired. |
203 |
|
Certificate Server Recovered |
Sent when MyID has recovered from a certificate server error |
157 |
|
Certificate Server Status |
Sent when an error is encountered communicating with a certificate server |
156 |
|
CertificateExpired |
Sent when a certificate has expired |
153 |
|
CertificateExpiring |
Sent when a certificate is about to expire |
152 |
|
Credential Licence Limit approaching |
Sent to an administrator when the system is approaching the license limit |
135 |
|
Credential Licence Limit exceeded |
Sent to an administrator when the system has exceeded its license limit |
136 |
|
Credential Licence Limit reached |
Sent to an administrator when the system has reached license limit |
137 |
|
CredentialExpired |
Sent when a credential has expired |
155 |
|
CredentialExpiring |
Sent when a credential is about to expire |
154 |
|
DC Job Logon Code |
Sent to the user when their smart card is ready for collection |
147 |
|
Email signing certificate invalid |
Send when an application servers email signing certificate is incorrectly configured, or not present. |
145 |
|
Failed Email Notification |
Sent to an administrator when an email has failed to send |
12 |
|
Issue Card Notification |
Sent to a user who has a card awaiting issuance |
4 |
|
Issue Token Notification |
Sent to a user who has a token awaiting issuance |
7 |
|
Job Logon Code |
Sent to the user when their smart card is ready for collection |
134 |
|
Job OTP |
Sent to the user for Job based OTP |
131 |
|
Job OTP No Device |
Sent to the user when their job is ready for collection |
138 |
|
Job OTP With Device |
Sent to the user when their job is ready for collection |
139 |
|
Licence Limit approaching |
Sent to an administrator when the system is approaching the license limit |
8 |
|
Licence Limit exceeded |
Sent to an administrator when the system has exceeded its license limit |
9 |
|
Licence Limit reached |
Sent to an administrator when the system has reached license limit |
10 |
|
Logon Code Notification |
Logon code notification |
104 |
|
LogonCodeLockout |
Sent to the user when their logon code is answered incorrectly too many times it becomes locked |
140 |
|
Mobile Provisioning |
Email sent during Request ID when Email option selected |
124 |
|
Mobile Provisioning Code |
Sent during mobile provisioning to authenticate the phone recipient. |
141 |
|
Mobile Soft Certificate Validated |
Mobile soft certificate validated |
120 |
|
Notification Failed |
URL notification failure |
111 |
|
Notification Failure |
URL notification failure |
105 |
|
Notification Success |
URL notification success |
107 |
|
QALockout |
Sent to the user when their security questions are answered incorrectly too many times and their security phrases become locked |
132 |
|
Renew Card Notification |
Sent to the card recipient when a card is approaching its expiry date |
121 |
|
Renew Card Notification First |
Sent to the card recipient when a card is approaching its expiry date |
122 |
|
Renew Card Notification Second |
Sent to the card recipient when a card has expired |
123 |
|
Renew Certificate Notification |
Sent to the certificate recipient when a certificate has expired |
3 |
|
Renew Certificate Notification Expired |
Sent to the certificate recipient when a certificate has expired |
127 |
|
Renew Certificate Notification Expired Mobile |
Sent to the certificate recipient when a certificate is approaching its expiry date |
130 |
|
Renew Certificate Notification First |
Sent to the certificate recipient via SMS when a certificate is approaching its expiry date |
1 |
|
Renew Certificate Notification First |
Sent to the certificate recipient when a certificate is approaching its expiry date |
125 |
|
Renew Certificate Notification First Mobile |
Sent to the certificate recipient when a certificate is approaching its expiry date |
128 |
|
Renew Certificate Notification First Mobile |
Sent to the certificate recipient when a certificate is approaching its expiry date |
200 |
|
Renew Certificate Notification Second |
Sent to the certificate recipient when a certificate is approaching its expiry date |
2 |
|
Renew Certificate Notification Second |
Sent to the certificate recipient when a certificate is approaching its expiry date |
126 |
|
Renew Certificate Notification Second Mobile |
Sent to the certificate recipient when a certificate is approaching its expiry date |
129 |
|
Replacement Card Notification |
Sent to a user who has a card replacement awaiting issuance |
102 |
|
Reprovision Notification |
Sent to the user when reprovision is ready for collection onto their devices |
143 |
|
Reprovision Notification Mobile |
Sent to the user when reprovision is ready for collection onto their mobile devices |
144 |
|
ServicePasswordExpired |
Sent when a user account has expired |
151 |
|
ServicePasswordExpiring |
Sent when a user account is about to expire |
150 |
|
Software Certificate Notification |
Sent to a user who has a pending software certificate request |
112 |
|
Time Licence Expired |
Sent to inform the admin their time based license has expired |
101 |
|
Time Licence Expiring |
Sent to inform the admin of impending time based license expiry |
100 |
|
Unlock Code |
Unlock code for account |
28 |
|
User Vetting Date Expired |
Sent to the administrator when a user's identity check has expired. |
201 |
Note: Additional PIV-specific email templates are also available on PIV systems.
Three different templates are associated with card renewal, certificate renewal and the license limit. They are used to:
- Notify the recipient that some action is required.
- Remind the recipient that some action is required.
- Inform the recipient that the threshold has passed.
For more information on notifications, including certificate authority status notifications, contact customer support quoting reference SUP-222.
13.3.1 Triggering the notification
Notifications are triggered at specific times before the event, or on the event itself. The default settings are as follows:
|
Days left |
Email template |
Description |
|---|---|---|
|
0 |
Apply Update Notification |
Apply update |
|
0 |
Cancel Card Notification |
Cancel card task. No longer used. This notification appears only on upgraded systems. |
|
28 |
Renew Card Notification |
CardRenewal |
|
7 |
Renew Card Notification First |
CardRenewal |
|
3 |
Renew Card Notification First |
CardRenewal |
|
1 |
Renew Card Notification First |
CardRenewal |
|
0 |
Renew Card Notification Second |
CardRenewal |
|
28 |
Renew Certificate Notification First |
CertRenewal |
|
21 |
Renew Certificate Notification Second |
CertRenewal |
|
14 |
Renew Certificate Notification Second |
CertRenewal |
|
7 |
Renew Certificate Notification Second |
CertRenewal |
|
0 |
Renew Certificate Notification |
CertRenewal |
|
0 |
Issue Card Notification |
Issue card task |
|
0 |
Replacement Card Notification |
Issue replacement card task |
|
0 |
Issue Token Notification |
Issue Token Task |
|
0 |
Reprovision Notification |
Reprovision Card task |
|
0 |
Software Certificate Notification |
Request a soft (browser) certificate for a user |
For example, for the CertRenewal notifications:
-
An initial message is sent to the certificate holder 28 days before a certificate expiry date.
When the first message is sent out, MyID creates a job to renew the user's certificate.
- A reminder message (the same template, but with a different number of remaining days being substituted for a variable) is sent at 21 days, 14 days and 7 days before the certificate expiry date.
-
A message stating that the certificate has expired is sent on the certificate expiry date (0 days).
If you want to alter when these notifications are sent, contact customer support quoting reference SUP-222.